home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3w / ufmGetBitmap.z / ufmGetBitmap
Encoding:
Text File  |  2002-10-03  |  10.0 KB  |  133 lines
  1.  
  2.  
  3.  
  4. uuuuffffmmmmGGGGeeeettttBBBBiiiittttmmmmaaaapppp((((3333wwww))))                                              uuuuffffmmmmGGGGeeeettttBBBBiiiittttmmmmaaaapppp((((3333wwww))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _uuuu_ffff_mmmm_GGGG_eeee_tttt_BBBB_iiii_tttt_mmmm_aaaa_pppp - get a character bitmap
  10.  
  11. CCCC SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_uuuu_ffff_mmmm_...._hhhh_>>>>
  13.  
  14.      _iiii_nnnn_tttt _uuuu_ffff_mmmm_GGGG_eeee_tttt_BBBB_iiii_tttt_mmmm_aaaa_pppp_((((_uuuu_nnnn_ssss_iiii_gggg_nnnn_eeee_dddd _iiii_nnnn_tttt _nnnn_TTTT_yyyy_pppp_eeee_ffff_aaaa_cccc_eeee_HHHH_aaaa_nnnn_dddd_llll_eeee_ssss_,,,,
  15.           _uuuu_nnnn_ssss_iiii_gggg_nnnn_eeee_dddd _iiii_nnnn_tttt _****_tttt_yyyy_pppp_eeee_ffff_aaaa_cccc_eeee_HHHH_aaaa_nnnn_dddd_llll_eeee_ssss_,,,, _iiii_nnnn_tttt _cccc_hhhh_aaaa_rrrr_CCCC_oooo_dddd_eeee_TTTT_yyyy_pppp_eeee_,,,,
  16.           _uuuu_nnnn_ssss_iiii_gggg_nnnn_eeee_dddd _iiii_nnnn_tttt _nnnn_CCCC_hhhh_aaaa_rrrr_CCCC_oooo_dddd_eeee_ssss_,,,, _vvvv_oooo_iiii_dddd _****_cccc_hhhh_aaaa_rrrr_CCCC_oooo_dddd_eeee_ssss_,,,, _iiii_nnnn_tttt _pppp_iiii_xxxx_eeee_llll_SSSS_iiii_zzzz_eeee_,,,,
  17.           _ffff_llll_oooo_aaaa_tttt _aaaa_nnnn_gggg_llll_eeee_,,,, _uuuu_nnnn_ssss_iiii_gggg_nnnn_eeee_dddd _iiii_nnnn_tttt _****_nnnn_CCCC_hhhh_aaaa_rrrr_BBBB_iiii_tttt_mmmm_aaaa_pppp_ssss_,,,, _uuuu_ffff_mmmm_BBBB_iiii_tttt_mmmm_aaaa_pppp _****_****_cccc_hhhh_aaaa_rrrr_BBBB_iiii_tttt_mmmm_aaaa_pppp_ssss_))))
  18.  
  19. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      _uuuu_ffff_mmmm_GGGG_eeee_tttt_BBBB_iiii_tttt_mmmm_aaaa_pppp gets bitmaps for specified characters.  You can get a
  21.      character bitmap only for those typefaces for which bitmap or outline
  22.      font files were found, that is, those typefaces which have the bit
  23.      _u_f_m_T_y_p_e_f_a_c_e_B_i_t_m_a_p_s set to 1 in their data structures of the type
  24.      _u_f_m_T_y_p_e_f_a_c_e.
  25.  
  26.      _n_T_y_p_e_f_a_c_e_H_a_n_d_l_e_s specifies the number of entries (typeface handles) in
  27.      the array _t_y_p_e_f_a_c_e_H_a_n_d_l_e_s.
  28.  
  29.      _t_y_p_e_f_a_c_e_H_a_n_d_l_e_s specifies one or more handles for open typefaces.  Use
  30.      the function _uuuu_ffff_mmmm_OOOO_pppp_eeee_nnnn_TTTT_yyyy_pppp_eeee_ffff_aaaa_cccc_eeee to open a typeface, and get a handle for
  31.      that typeface.
  32.  
  33.      If you specify more than one typeface handle, _uuuu_ffff_mmmm_GGGG_eeee_tttt_BBBB_iiii_tttt_mmmm_aaaa_pppp will look for
  34.      bitmap fonts of the size _p_i_x_e_l_S_i_z_e in specified typefaces.  If it does
  35.      not find a requested bitmap font, it will create it.  Then it will look
  36.      for the bitmap of a specified character in the bitmap font for the first
  37.      specified typeface.  If it does not find it in that font, it will look
  38.      for that bitmap in the next bitmap font.  It will stop looking as soon as
  39.      it finds the requested character bitmap.  If it cannot find that bitmap,
  40.      it will return the bitmap for the default character.  If _uuuu_ffff_mmmm_GGGG_eeee_tttt_BBBB_iiii_tttt_mmmm_aaaa_pppp
  41.      cannot find the bitmap even for the default character, it will return an
  42.      error code.
  43.  
  44.      _c_h_a_r_C_o_d_e_T_y_p_e specifies a 1-byte character code (_U_F_M__B_Y_T_E_1), a Unicode
  45.      UCS-2 code (_U_F_M__U_C_S_2), a Unicode UCS-4 code (_U_F_M__U_C_S_4), a 2-byte
  46.      character code (_U_F_M__B_Y_T_E_2), or a 4-byte character code (_U_F_M__B_Y_T_E_4).
  47.  
  48.      _n_C_h_a_r_C_o_d_e_s specifies the number of elements in the array _c_h_a_r_C_o_d_e_s.  Set
  49.      _n_C_h_a_r_C_o_d_e_s to 0 if you want bitmaps for all characters in a specified
  50.      typeface.  If you want bitmaps for only some characters, use the array
  51.      _c_h_a_r_C_o_d_e_s to specify the character codes of those characters.
  52.  
  53.      _p_i_x_e_l_S_i_z_e specifies the size of requested bitmaps in pixels.
  54.      _uuuu_ffff_mmmm_GGGG_eeee_tttt_BBBB_iiii_tttt_mmmm_aaaa_pppp will extract requested character bitmaps from a bitmap font
  55.      of the specified pixel size.
  56.  
  57.      _a_n_g_l_e specifies the number of degrees by which character bitmaps must be
  58.      rotated in a counterclockwise direction.  This is in addition to any
  59.      rotation specified in the header of a font.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. uuuuffffmmmmGGGGeeeettttBBBBiiiittttmmmmaaaapppp((((3333wwww))))                                              uuuuffffmmmmGGGGeeeettttBBBBiiiittttmmmmaaaapppp((((3333wwww))))
  71.  
  72.  
  73.  
  74.      _uuuu_ffff_mmmm_GGGG_eeee_tttt_BBBB_iiii_tttt_mmmm_aaaa_pppp returns the number of character bitmaps it finds
  75.      (_n_C_h_a_r_B_i_t_m_a_p_s) and the address of the array in which it stores those
  76.      character bitmaps (_u_f_m_B_i_t_m_a_p).
  77.  
  78.      When you are finished with the array (_u_f_m_B_i_t_m_a_p), you can free it by
  79.      calling _uuuu_ffff_mmmm_FFFF_rrrr_eeee_eeee_BBBB_iiii_tttt_mmmm_aaaa_pppp with the argument values that were returned by
  80.      _uuuu_ffff_mmmm_GGGG_eeee_tttt_BBBB_iiii_tttt_mmmm_aaaa_pppp.
  81.  
  82.      A bitmap image provided by the function _uuuu_ffff_mmmm_GGGG_eeee_tttt_BBBB_iiii_tttt_mmmm_aaaa_pppp should be
  83.      interpreted the same way as image data for the OpenGL function
  84.      _gggg_llll_DDDD_rrrr_aaaa_wwww_PPPP_iiii_xxxx_eeee_llll_ssss, with width and height corresponding to the width and height
  85.      arguments in that function, and with type set to _GGGG_LLLL______BBBB_IIII_TTTT_MMMM_AAAA_PPPP and format set
  86.      to _GGGG_LLLL______CCCC_OOOO_LLLL_OOOO_RRRR______IIII_NNNN_DDDD_EEEE_XXXX.
  87.  
  88.      Each row of the bitmap is padded to a 4-byte boundary.  If you want to
  89.      use the information provided by _uuuu_ffff_mmmm_GGGG_eeee_tttt_BBBB_iiii_tttt_mmmm_aaaa_pppp to create OpenGL font
  90.      display lists, that is, to call OpenGL functions _gggg_llll_NNNN_eeee_wwww_LLLL_iiii_ssss_tttt, _gggg_llll_BBBB_iiii_tttt_mmmm_aaaa_pppp, and
  91.      _gggg_llll_EEEE_nnnn_dddd_LLLL_iiii_ssss_tttt, you should start by calling _gggg_llll_PPPP_iiii_xxxx_eeee_llll_SSSS_tttt_oooo_rrrr_eeee function with the
  92.      arguments _GGGG_LLLL______UUUU_NNNN_PPPP_AAAA_CCCC_KKKK______AAAA_LLLL_IIII_GGGG_NNNN_MMMM_EEEE_NNNN_TTTT and 4.  For example, if you decide to use
  93.      the function _gggg_llll_PPPP_iiii_xxxx_eeee_llll_SSSS_tttt_oooo_rrrr_eeee_iiii, you should specify
  94.      _gggg_llll_PPPP_iiii_xxxx_eeee_llll_SSSS_tttt_oooo_rrrr_eeee_iiii_((((_GGGG_LLLL______UUUU_NNNN_PPPP_AAAA_CCCC_KKKK______AAAA_LLLL_IIII_GGGG_NNNN_MMMM_EEEE_NNNN_TTTT_,,,, _4444_)))).
  95.  
  96. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  97.      ufmGetTransformedBitmap(3w), ufmFreeBitmap(3w).
  98.  
  99. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  100.      If _uuuu_ffff_mmmm_GGGG_eeee_tttt_BBBB_iiii_tttt_mmmm_aaaa_pppp is not able to allocate the memory it needs, it will
  101.      return the value _UUUU_FFFF_MMMM______OOOO_UUUU_TTTT______OOOO_FFFF______MMMM_EEEE_MMMM_OOOO_RRRR_YYYY.  If the values of one or more
  102.      arguments are not valid, _uuuu_ffff_mmmm_GGGG_eeee_tttt_BBBB_iiii_tttt_mmmm_aaaa_pppp will return the value
  103.      _UUUU_FFFF_MMMM______IIII_NNNN_VVVV_AAAA_LLLL_IIII_DDDD______VVVV_AAAA_LLLL_UUUU_EEEE.  _UUUU_FFFF_MMMM______OOOO_UUUU_TTTT______OOOO_FFFF______MMMM_EEEE_MMMM_OOOO_RRRR_YYYY and _UUUU_FFFF_MMMM______IIII_NNNN_VVVV_AAAA_LLLL_IIII_DDDD______VVVV_AAAA_LLLL_UUUU_EEEE are defined
  104.      in the header file <_u_f_m._h>.
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.